GCR ID API: gcrId

The GCR ID API retrieves the Golden Customer Record (GCR) ID, a unique identifier for individual customer profiles within Real-time CDP. This API allows marketers to manage and track customer identities effectively.

Notes:

The gcrId resource is accessible for utilization within the create access token API.
The request body accommodates keys as configured under the app_configproperty = pp.identity.mapXml.

API Endpoint and Method

URL Format

Copy

https://{B2B_DOMAIN_URL}/api/v1/profile/b2b/gcr

Example URL

Copy

https://api-dev.algonomy.com/rcdpapi/api/v1/profile/b2b/gcr

HTTP Method

POST

Request Header Parameters

Parameter	Type	Required or Optional	Description
access_token	String	Required	Specifies the access token obtained from the create access token API.
tenant_hash	String	Required	Specifies the tenant hash shared with the tenant.
gcrId	String	Required	Specifies the Golden Customer Record ID (GCR ID).
mobile_number	String	Required	Specifies customer's mobile number. Example: "1212121212"
email_address	String	Required	Specifies customer's email address. Example: "customer@example.com"
customer_code_external	String	Required	Specifies the external customer code. Example: "123456"

Notes:

You can send all the parameters (gcrId, mobile_number, and email_address) with the request or just one, as at least one parameter is required.
These parameters are supported based on the configuration. If your deployment is configured to use them as columns for deduplication, they will be available for use in the API call.

Request Body

You can provide one or more customer identity parameters to query the GCR ID:

Copy

1
2
3
4
5
{
"email_address":"abc@gmail.com",
"customer_code_external":"12355",
"mobile_number":"9086798721"
}

Response Body

A successful request returns a "200-OK" status code, accompanied by the retrieved data in the response.

Copy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
    "status": "OK",
    "data": [
        {
            "status": "Not available",
            "gcrId": -1,
            "identifier": {
                "email_address": "abc@gmail.com",
                "mobile_number": "9086798721"
            }
        },
        {
            "status": "Available",
            "gcrId": 3510,
            "identifier": {
                "customer_code_external": "ext2"
            }
        }
    ]
}